sort-keys
Advanced tools
Package description
The sort-keys npm package is used to sort the keys of an object, either in ascending or descending order, based on a custom comparator function if provided. This can be particularly useful for organizing JSON objects for readability or for ensuring that objects are in a consistent order when stringifying them, which can be important for hashing and caching mechanisms.
Sort keys in ascending order
Sorts the keys of an object in ascending order. This is the default behavior without providing any additional options.
const sortKeys = require('sort-keys');
const sorted = sortKeys({c: 0, a: 0, b: 0});
console.log(sorted); // Output: { a: 0, b: 0, c: 0 }Sort keys using a custom comparator
Sorts the keys of an object using a custom comparator function. In this example, the keys are sorted in descending order.
const sortKeys = require('sort-keys');
const sorted = sortKeys({a: 0, b: 1, c: 2}, {
compare: (a, b) => b.localeCompare(a)
});
console.log(sorted); // Output: { c: 2, b: 1, a: 0 }Deep sorting of nested objects
Sorts the keys of an object and all nested objects. This is useful for deep sorting complex objects.
const sortKeys = require('sort-keys');
const obj = {
c: {c2: 0, c1: 0},
a: {a2: 0, a1: 0},
b: 0
};
const sorted = sortKeys(obj, {deep: true});
console.log(sorted); // Output: { a: { a1: 0, a2: 0 }, b: 0, c: { c1: 0, c2: 0 } }Provides a function to sort arrays of objects based on the values at specified keys. While sort-keys sorts the keys of an object, lodash.sortby sorts the elements of an array based on one or more properties.
Similar to sort-keys with deep sorting capabilities, but deep-sort-object is specifically designed to handle deep sorting of objects without the need for additional configuration.
Readme
Sort the keys of an object
Useful to get a deterministically ordered object, as the order of keys can vary between engines.
$ npm install sort-keys
const sortKeys = require('sort-keys');
sortKeys({c: 0, a: 0, b: 0});
//=> {a: 0, b: 0, c: 0}
sortKeys({b: {b: 0, a: 0}, a: 0}, {deep: true});
//=> {a: 0, b: {a: 0, b: 0}}
sortKeys({b: [{b: 0, a: 0}], a: 0}, {deep: true});
//=> {a: 0, b: [{a: 0, b: 0}]}
sortKeys({c: 0, a: 0, b: 0}, {
compare: (a, b) => -a.localeCompare(b)
});
//=> {c: 0, b: 0, a: 0}
sortKeys([{b: 0, a:2}], {deep: true});
//=> [{a: 2, b: 0}]
Returns a new object with sorted keys.
Type: object | Array
Type: object
Type: boolean
Default: false
Recursively sort keys, including keys of objects inside arrays.
Type: Function
FAQs
Sort the keys of an object
The npm package sort-keys receives a total of 8,620,177 weekly downloads. As such, sort-keys popularity was classified as popular.
We found that sort-keys demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The June TC39 meeting wrapped up this week with eight proposals moving on to the next stage. Here's a quick roundup of the features that the committee approved to advance.
Security News
Cyber extortion in the US and Canada hit record levels in 2023, with ransomware attacks surging and median ransom demands skyrocketing, though fewer companies are choosing to pay ransoms.
Security News
Ecma TC39 is meeting this week and has moved key ECMAScript proposals forward, advancing Deferred Import Evaluation, Error.isError(), RegExp Escaping, and Promise.try to the next stages.